Skip to main content
Feedback

Policy templates

Updated 

A policy template is a named, versioned bundle of existing policy rules you can apply to one or more APIs in Boomi API Gateway as a single unit, instead of configuring each rule individually. An administrator defines the template, and users with appropriate permissions can then apply it to a new API without assigning the underlying rules individually. Policy templates show up automatically in API Control Plane (ACP) from a connected Boomi API Gateway environment, where you can view and apply them; refer to Configuration API Policy Templates.

Policy templates rely on automatic versioning to manage structural updates safely across APIs. Depending on the template's attachment state and the type of change made, an edit either creates a new version or updates the existing version in place. For more information, refer to Editing a policy template.

A template references existing policy rules rather than copying them. If multiple templates include the same rule, all of those templates point to that single rule definition, so editing the rule updates it everywhere it appears.

Each rule keeps its own Execution Timing within the template framework.

Policy templates list

The Policy Templates list page lists all existing templates. Each version of a template appears as its own row, with its own name, description, version, API count, and number of policies, and the list supports search and pagination. Click a template's name to view the list of policy rules and APIs attached to the template. If your role does not include the API Management - APIs privilege, the list still displays, but create, edit, and delete actions are unavailable. Refer to API Management Roles and Privileges.

Configuration reference

FieldDescriptionRequired
Template nameThe name of the reusable policy template, as shown in the list.Yes
DescriptionA plain-text description of the template's purpose, as shown in the list.No
VersionThe template's version number, assigned automatically.Automatic
API countThe number of deployed APIs the template is currently attached to.N/A
No of PoliciesThe number of policy rules included in the template.Yes (at least one)
Note: The backend does not enforce this and can persist a template with no rules.
EditFrom the row's Actions menu, opens the template to change its description or policy rules. Refer to Editing a policy template.N/A
Add to APIFrom the row's Actions menu, attach the template to one or more deployed APIs at a specified path. Refer to Assigning a template to an API.N/A
DeleteFrom the row's Actions menu, delete the template. You cannot delete a template if it is attached to any API. Refer to Deleting a policy template.N/A

Policy templates GraphQL APIs

You can also query policy templates programmatically using the apiPolicyTemplate and apiPolicyTemplates GraphQL operations.

On this Page